[Beta] Search documents

curl --request GET \
  --url https://api.tightknit.ai/admin/v0/search \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "page": 0,
    "per_page": 10,
    "count": 10,
    "total_records": 100,
    "total_pages": 10,
    "has_next": true,
    "records": [
      {
        "id": "w6sy87nsu78w",
        "created_at": "2024-02-01 04:04:39.198523+00",
        "updated_at": "2024-02-01 04:04:39.198523+00",
        "content_created_at": "2024-02-01 04:04:39.198523+00",
        "latest_activity_at": "2024-02-01 04:04:39.198523+00",
        "title": "My Post",
        "slug": "my-post",
        "feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
        "post_detail_display_format": "discussion",
        "author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
        "read_time_minutes": 5,
        "source": "slack",
        "file_attachments_count": 1,
        "reactions_count": 10,
        "comments_count": 2,
        "body_plaintext": "<string>",
        "author": {
          "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
          "created_at": "2024-02-01 04:04:39.198523+00",
          "preferred_name": "John D.",
          "preferred_image_original": "https://example.com/image.png",
          "preferred_image_1024": "https://example.com/image1024.png",
          "preferred_image_512": "https://example.com/image512.png",
          "preferred_image_192": "https://example.com/image192.png",
          "preferred_image_72": "https://example.com/image72.png",
          "preferred_image_48": "https://example.com/image48.png",
          "preferred_image_32": "https://example.com/image32.png",
          "preferred_image_24": "https://example.com/image24.png",
          "first_name": "John",
          "last_name": "Doe",
          "email": "[email protected]",
          "slack_user_id": "U088HCYD418",
          "slack_is_admin": false,
          "slack_is_bot": false,
          "slack_first_name": "<string>",
          "slack_last_name": "<string>",
          "slack_image_72": "https://example.com/image72.png",
          "slack_image_original": "https://example.com/image.png"
        },
        "feed": {
          "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
          "label": "My Feed",
          "slug": "my-feed"
        },
        "body_prosemirror": {},
        "slack_message": {
          "id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
          "message_ts": 1737338258.891569,
          "blocks": [
            {
              "type": "rich_text",
              "elements": [
                {
                  "type": "rich_text_section",
                  "elements": [
                    {
                      "text": "Hello, world!",
                      "type": "text"
                    }
                  ]
                }
              ]
            }
          ],
          "markdown": "This is the message mrkdwn text.",
          "permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
          "parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751",
          "username": "Service Agent",
          "icon": "https://example.com/icon.png"
        },
        "cover_image_file_id": "12345678-90ab-cdef-1234-567890ab",
        "cover_image_url": "https://example.com/my-image.png",
        "references": {
          "mentioned_slack_users": [
            {
              "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
              "preferred_name": "John D.",
              "slack_user_id": "U088HCYD418"
            }
          ],
          "mentioned_slack_channels": [
            {
              "slack_channel": {
                "id": "C088TB6CRL4",
                "name": "general"
              },
              "feed": {
                "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
                "label": "My Feed",
                "slug": "my-feed"
              }
            }
          ],
          "custom_emojis": [
            {
              "alias": "<string>",
              "name": "wow",
              "url": "https://example.com/wow.png"
            }
          ],
          "urls": [
            {
              "order_seen": 0,
              "is_embedded_media": false,
              "is_image": true,
              "is_video": false,
              "url": "https://example.com/tacos.png"
            }
          ]
        }
      }
    ]
  }
}

GET

admin

curl --request GET \
  --url https://api.tightknit.ai/admin/v0/search \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "page": 0,
    "per_page": 10,
    "count": 10,
    "total_records": 100,
    "total_pages": 10,
    "has_next": true,
    "records": [
      {
        "id": "w6sy87nsu78w",
        "created_at": "2024-02-01 04:04:39.198523+00",
        "updated_at": "2024-02-01 04:04:39.198523+00",
        "content_created_at": "2024-02-01 04:04:39.198523+00",
        "latest_activity_at": "2024-02-01 04:04:39.198523+00",
        "title": "My Post",
        "slug": "my-post",
        "feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451",
        "post_detail_display_format": "discussion",
        "author_profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
        "read_time_minutes": 5,
        "source": "slack",
        "file_attachments_count": 1,
        "reactions_count": 10,
        "comments_count": 2,
        "body_plaintext": "<string>",
        "author": {
          "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
          "created_at": "2024-02-01 04:04:39.198523+00",
          "preferred_name": "John D.",
          "preferred_image_original": "https://example.com/image.png",
          "preferred_image_1024": "https://example.com/image1024.png",
          "preferred_image_512": "https://example.com/image512.png",
          "preferred_image_192": "https://example.com/image192.png",
          "preferred_image_72": "https://example.com/image72.png",
          "preferred_image_48": "https://example.com/image48.png",
          "preferred_image_32": "https://example.com/image32.png",
          "preferred_image_24": "https://example.com/image24.png",
          "first_name": "John",
          "last_name": "Doe",
          "email": "[email protected]",
          "slack_user_id": "U088HCYD418",
          "slack_is_admin": false,
          "slack_is_bot": false,
          "slack_first_name": "<string>",
          "slack_last_name": "<string>",
          "slack_image_72": "https://example.com/image72.png",
          "slack_image_original": "https://example.com/image.png"
        },
        "feed": {
          "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
          "label": "My Feed",
          "slug": "my-feed"
        },
        "body_prosemirror": {},
        "slack_message": {
          "id": "1519c63a-f8cf-4897-a76e-ef556d5fd915",
          "message_ts": 1737338258.891569,
          "blocks": [
            {
              "type": "rich_text",
              "elements": [
                {
                  "type": "rich_text_section",
                  "elements": [
                    {
                      "text": "Hello, world!",
                      "type": "text"
                    }
                  ]
                }
              ]
            }
          ],
          "markdown": "This is the message mrkdwn text.",
          "permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
          "parent_slack_message_id": "97d5c5d6-d036-4223-9bd3-876a0cf47751",
          "username": "Service Agent",
          "icon": "https://example.com/icon.png"
        },
        "cover_image_file_id": "12345678-90ab-cdef-1234-567890ab",
        "cover_image_url": "https://example.com/my-image.png",
        "references": {
          "mentioned_slack_users": [
            {
              "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
              "preferred_name": "John D.",
              "slack_user_id": "U088HCYD418"
            }
          ],
          "mentioned_slack_channels": [
            {
              "slack_channel": {
                "id": "C088TB6CRL4",
                "name": "general"
              },
              "feed": {
                "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
                "label": "My Feed",
                "slug": "my-feed"
              }
            }
          ],
          "custom_emojis": [
            {
              "alias": "<string>",
              "name": "wow",
              "url": "https://example.com/wow.png"
            }
          ],
          "urls": [
            {
              "order_seen": 0,
              "is_embedded_media": false,
              "is_image": true,
              "is_video": false,
              "url": "https://example.com/tacos.png"
            }
          ]
        }
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

The page number (0-indexed)

Example:

0

per_page

integer

The number of records per page

Example:

10

string

required

Search query string

Required string length: 1 - 256

Example:

"search term"

type

enum<string>

required

The entity to search for

Available options:

post,

comment

Example:

"post"

Response

Returns search results

success

boolean

required

data

object

required

Option 1
Option 2

Show child attributes

data.page

number

required

The current page number (0-indexed)

Required range: x >= 0

Example:

0

data.per_page

number

required

The number of records per page

Required range: 1 <= x <= 20

Example:

10

data.count

number

required

The number of records in the current page

Required range: x >= 0

Example:

10

data.total_records

number

required

The total number of records

Required range: x >= 0

Example:

100

data.total_pages

number

required

The total number of pages

Example:

10

data.has_next

boolean

required

Whether there is a next page of additional records after the current page

Example:

true

data.records

object[]

required

The list of records in the current page

Show child attributes

data.records.id

string

required

Example:

"w6sy87nsu78w"

data.records.created_at

string<date-time>

required

When the post was created

Example:

"2024-02-01 04:04:39.198523+00"

data.records.updated_at

string<date-time>

required

When the post was last updated

Example:

"2024-02-01 04:04:39.198523+00"

data.records.content_created_at

string<date-time>

required

When the source of the content was created (e.g. when the post was written, or when the Slack message was originally sent)

Example:

"2024-02-01 04:04:39.198523+00"

data.records.latest_activity_at

string<date-time>

required

When the latest activity on the thread occurred, including the post or any of its comments.

Example:

"2024-02-01 04:04:39.198523+00"

data.records.title

string

required

Example:

"My Post"

data.records.slug

string

required

Example:

"my-post"

data.records.feed_id

string

required

Example:

"91795199-9d00-47c7-bd6e-d4049bb63451"

data.records.post_detail_display_format

enum<string>

required

The display format of the post detail page

Available options:

discussion,

blog

Example:

"discussion"

data.records.author_profile_id

string

required

Example:

"03ff107d-099f-4426-81a6-a04690d7afz3"

data.records.read_time_minutes

number

required

The estimated time to read the post in minutes

Example:

5

data.records.source

enum<string>

required

The source of the Post content, i.e. where it was created

Available options:

slack,

site

Example:

"slack"

data.records.file_attachments_count

number

required

Example:

1

data.records.reactions_count

number

required

Example:

10

data.records.comments_count

number

required

Example:

2

data.records.body_plaintext

string

required

data.records.author

object

required

Show child attributes

data.records.author.profile_id

string

required

Example:

"03ff107d-099f-4426-81a6-a04690d7afz3"

data.records.author.created_at

string<date-time>

required

Example:

"2024-02-01 04:04:39.198523+00"

data.records.author.preferred_name

string

required

Example:

"John D."

data.records.author.preferred_image_original

string | null

required

Example:

"https://example.com/image.png"

data.records.author.preferred_image_1024

string | null

required

Example:

"https://example.com/image1024.png"

data.records.author.preferred_image_512

string | null

required

Example:

"https://example.com/image512.png"

data.records.author.preferred_image_192

string | null

required

Example:

"https://example.com/image192.png"

data.records.author.preferred_image_72

string | null

required

Example:

"https://example.com/image72.png"

data.records.author.preferred_image_48

string | null

required

Example:

"https://example.com/image48.png"

data.records.author.preferred_image_32

string | null

required

Example:

"https://example.com/image32.png"

data.records.author.preferred_image_24

string | null

required

Example:

"https://example.com/image24.png"

data.records.author.first_name

string | null

Example:

"John"

data.records.author.last_name

string | null

Example:

"Doe"

data.records.author.email

string<email> | null

Example:

"[email protected]"

data.records.author.slack_user_id

string | null

Example:

"U088HCYD418"

data.records.author.slack_is_admin

boolean | null

Example:

false

data.records.author.slack_is_bot

boolean | null

Example:

false

data.records.author.slack_first_name

string | null

deprecated

DEPRECATED: use first_name instead

data.records.author.slack_last_name

string | null

deprecated

DEPRECATED: use last_name instead

data.records.author.slack_image_72

string | null

Example:

"https://example.com/image72.png"

data.records.author.slack_image_original

string | null

Example:

"https://example.com/image.png"

data.records.feed

object

required

Feed snippet

Show child attributes

data.records.feed.id

string

required

Example:

"91795199-9d00-47c7-bd6e-d4049bb63451"

data.records.feed.label

string

required

Example:

"My Feed"

data.records.feed.slug

string

required

Example:

"my-feed"

data.records.body_prosemirror

object

Show child attributes

data.records.body_prosemirror.{key}

unknown

data.records.slack_message

object

Slack Message

Show child attributes

data.records.slack_message.id

string

required

Example:

"1519c63a-f8cf-4897-a76e-ef556d5fd915"

data.records.slack_message.message_ts

number

required

The Slack message timestamp

Example:

1737338258.891569

data.records.slack_message.blocks

object[]

required

The message in Slack blocks format for rich text input element.

Show child attributes

data.records.slack_message.blocks.type

enum<string>

required

Available options:

rich_text

data.records.slack_message.blocks.elements

object[]

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

data.records.slack_message.blocks.elements.type

enum<string>

required

Available options:

rich_text_section

data.records.slack_message.blocks.elements.elements

object[]

required

Show child attributes

data.records.slack_message.blocks.elements.elements.type

enum<string>

required

Available options:

broadcast

data.records.slack_message.blocks.elements.elements.range

enum<string>

required

Available options:

here,

channel,

everyone

data.records.slack_message.blocks.block_id

string

Example:

[
  {
    "type": "rich_text",
    "elements": [
      {
        "type": "rich_text_section",
        "elements": [{ "text": "Hello, world!", "type": "text" }]
      }
    ]
  }
]

data.records.slack_message.markdown

string

required

The Slack message content in mrkdwn format

Example:

"This is the message mrkdwn text."

data.records.slack_message.permalink

string | null

required

The URL permalink to the Slack message

Example:

"https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ"

data.records.slack_message.parent_slack_message_id

string | null

The ID of the top-most parent Slack message, if this is a threaded reply

Example:

"97d5c5d6-d036-4223-9bd3-876a0cf47751"

data.records.slack_message.username

string | null

The username display override for the author of the message, often used by Slack app bots

Example:

"Service Agent"

data.records.slack_message.icon

string<uri> | null

The icon display override for the author of the message, often used by Slack app bots

Example:

"https://example.com/icon.png"

data.records.cover_image_file_id

string | null

The ID of the cover image file

Example:

"12345678-90ab-cdef-1234-567890ab"

data.records.cover_image_url

string | null

The URL of the cover image for the post

Example:

"https://example.com/my-image.png"

data.records.references

object

References to external entities mentioned in the contents of the Slack blocks

Show child attributes

data.records.references.mentioned_slack_users

object[]

required

The users tagged in the Slack blocks

Show child attributes

data.records.references.mentioned_slack_users.profile_id

string

required

Example:

"03ff107d-099f-4426-81a6-a04690d7afz3"

data.records.references.mentioned_slack_users.preferred_name

string

required

Example:

"John D."

data.records.references.mentioned_slack_users.slack_user_id

string | null

Example:

"U088HCYD418"

data.records.references.mentioned_slack_channels

object[]

required

The channels at-mentioned in the Slack blocks

Show child attributes

data.records.references.mentioned_slack_channels.slack_channel

object

required

Slack Channel snippet

Show child attributes

data.records.references.mentioned_slack_channels.slack_channel.id

string

required

Example:

"C088TB6CRL4"

data.records.references.mentioned_slack_channels.slack_channel.name

string | null

required

Example:

"general"

data.records.references.mentioned_slack_channels.feed

object

Feed snippet

Show child attributes

data.records.references.mentioned_slack_channels.feed.id

string

required

Example:

"91795199-9d00-47c7-bd6e-d4049bb63451"

data.records.references.mentioned_slack_channels.feed.label

string

required

Example:

"My Feed"

data.records.references.mentioned_slack_channels.feed.slug

string

required

Example:

"my-feed"

data.records.references.custom_emojis

object[]

required

The custom emojis used in the Slack blocks

Show child attributes

data.records.references.custom_emojis.alias

string | null

required

The name of the aliased emoji, if this is an alias

data.records.references.custom_emojis.name

string

required

Example:

"wow"

data.records.references.custom_emojis.url

string | null

required

Example:

"https://example.com/wow.png"

data.records.references.urls

object[]

required

The URLs used in the Slack blocks

Show child attributes

data.records.references.urls.order_seen

number

required

0-indexed order of the URL in the Slack blocks

Example:

0

data.records.references.urls.is_embedded_media

boolean

required

Whether the URL is from media (e.g. image, video) embedded within the Slack blocks, instead of the raw URL appearing directly in text

Example:

false

data.records.references.urls.is_image

boolean

required

Whether the URL refers to an image

Example:

true

data.records.references.urls.is_video

boolean

required

Whether the URL refers to a video

Example:

false

data.records.references.urls.url

string

required

Example:

"https://example.com/tacos.png"

Retrieve post Triggered when an award is given

⌘I

Overview

Admin API

[Beta] Search documents

Authorizations

Query Parameters

Response